Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add basic support for example tag #1200

Merged
merged 2 commits into from
Mar 30, 2022
Merged

Conversation

hmil
Copy link
Contributor

@hmil hmil commented Mar 30, 2022

fix #1201

Version

Published prerelease version: v1.0.1-next.1

Changelog

🎉 This release contains work from a new contributor! 🎉

Thank you, Hadrien Milano (@hmil), for all your work!

🚀 Enhancement

  • feat: add basic support for example tag #1200 (@hmil)

🐛 Bug Fix

🔩 Dependency Updates

Authors: 3

@hmil hmil mentioned this pull request Mar 30, 2022
@hmil hmil changed the title add support for example tag feat: add support for example tag Mar 30, 2022
@hmil hmil changed the title feat: add support for example tag feat: add basic support for example tag Mar 30, 2022

const examples: unknown[] = [];
for (const example of jsDocTags.filter((tag) => tag.name === "example")) {
console.log(JSON.stringify(example.text));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove log

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops 😅

* "nested": "hello"
* }
*
* @example Another example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @example Another example
* @example An invalid example

* {
* "nested": "world"
* }
* @example Last example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* @example Last example
* @example Another invalid example

@domoritz domoritz merged commit fad197f into vega:next Mar 30, 2022
@domoritz
Copy link
Member

Thank you.

@github-actions
Copy link

🚀 PR was released in v1.1.0 🚀

@github-actions github-actions bot added released This issue/pull request has been released. and removed prerelease labels Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support @example tsdoc tag
2 participants